Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update structure and presentation #40

Merged

Conversation

razvand
Copy link
Contributor

@razvand razvand commented Dec 28, 2023

Prerequisite Checklist

  • Read the contribution guidelines regarding submitting new changes to the project;
  • Tested your changes against relevant architectures and platforms;
  • Updated relevant documentation (if needed).

Description of changes

Add entire contents of binary security class. Configure appropriate rendering in config.yaml. Make updates to content: placement, links, formatting.

@razvand razvand added kind/improve Content improvement area/infra Infrastructure-related changes labels Dec 28, 2023
@razvand razvand force-pushed the razvand/update-presentation branch 2 times, most recently from 1e9fdd2 to 3698507 Compare December 28, 2023 22:56
Make `README.md` instructions compatible with other repositories.

Signed-off-by: Razvan Deaconescu <[email protected]>
Remove trailing whitespace in `COPYING.md`.

Signed-off-by: Razvan Deaconescu <[email protected]>
Sync `CONTRIBUTING.md` contents with the one in the template repository.

Signed-off-by: Razvan Deaconescu <[email protected]>
Use correct links (URLs) to binary security content (SSS) in config.yaml
file.

Signed-off-by: Razvan Deaconescu <[email protected]>
Generated content (mostly slides) was added by mistake in the
repository. Remove it.

Signed-off-by: Razvan Deaconescu <[email protected]>
Add `.gitignore` file to ignore generated slide output files. Namely the
`_site/` directory and the `slides.md` file (resulted from
preprocessing).

Signed-off-by: Razvan Deaconescu <[email protected]>
Rename `activities/` directory to `drills/`. And rename `assets/` to
`media/`.

Also place `README.md` in `reading/` directory.

Signed-off-by: Razvan Deaconescu <[email protected]>
@razvand razvand force-pushed the razvand/update-presentation branch from 3698507 to cb587e7 Compare December 28, 2023 22:59
@gabrielmocanu
Copy link
Collaborator

I added the pr-deployment workflow to be able to render this PR.
Please update your branch to main.

@gabrielmocanu
Copy link
Collaborator

It looks ok to me, I think we should ignore for now SuperLinter workflow since it will be a lot of changes there.
I would focus on rendering the website and solving Checkpatch and Spellcheck workflows.

@razvand razvand force-pushed the razvand/update-presentation branch 5 times, most recently from 3a77ace to 51965aa Compare January 2, 2024 16:04
Reformat content to make it publishable via Docusaurus.

The `pwntools-intro` section was previously stored outside the
`chapters/` directory. Move it inside the `chapters/` directory.

Update formatting, links and configuration file (`config.yaml`) to new
structure.

Reformat Python code using `black`.

Apply linting (via `markdownlint-cli`) to Markdown files.

Signed-off-by: Razvan Deaconescu <[email protected]>
The `CPPLINT.cfg` file in the actions repository doesn't work. The
configuration file has to be part of the root repository, so we add it
here.

Signed-off-by: Razvan Deaconescu <[email protected]>
@razvand razvand force-pushed the razvand/update-presentation branch from 51965aa to e809d63 Compare January 2, 2024 16:18
Copy link
Member

@teodutu teodutu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I scrolled through the content and couldn't find any rendering issues. It looks alright.

@razvand razvand merged commit fa2bf67 into open-education-hub:main Jan 2, 2024
1 of 3 checks passed
@razvand razvand deleted the razvand/update-presentation branch January 2, 2024 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/infra Infrastructure-related changes kind/improve Content improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants